Skip to content

CI: Add markdownlint #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 4, 2020
Merged

CI: Add markdownlint #190

merged 1 commit into from
Jul 4, 2020

Conversation

ozkriff
Copy link
Member

@ozkriff ozkriff commented Jul 4, 2020

Consistency is King

Closes #30 ("CI: Add markdownlint check")

Copy link
Collaborator

@17cupsofcoffee 17cupsofcoffee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I'm a little surprised that a lint action goes to the trouble of setting up a Docker container, but it only adds 18s to the build, so whatever.

@ozkriff
Copy link
Member Author

ozkriff commented Jul 4, 2020

Yeah, that's a bit unfortunate. Maybe we'll find a better gh action later, atm I'm more interested in having the linter on CI at all)

@ozkriff
Copy link
Member Author

ozkriff commented Jul 4, 2020

⏲️ Merging in a few hrs if there're no objections.

Copy link
Collaborator

@kvark kvark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haven't heard of these before.
I think linting is most appropriate to code. In formatted text is less of a concern.

@ozkriff
Copy link
Member Author

ozkriff commented Jul 4, 2020

@kvark Well, the newsletter is written by many people at once, I'm afraid that we'll quickly face conflicts of different ways of writing the same thing. Also, MD isn't standardized enough - it's quite easy to step into differences between render engines (even in basic things like indents, quotes, and linebreaks) if you're not careful.

@kvark
Copy link
Collaborator

kvark commented Jul 4, 2020 via email

@ozkriff ozkriff merged commit 83a0db1 into source Jul 4, 2020
@ozkriff ozkriff deleted the i30_ci_markdownlint branch July 4, 2020 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CI: Add markdownlint checks
3 participants